Documentation facelift #242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Open
wiseodd
added
documentation
aleximmer
approved these changes
Oct 8, 2024
There was a problem hiding this comment.
Thanks a lot for updating the docs. They look super good now 💯
I got some warnings when running uv run mkdocs serve, not sure if these are serious:
SyntaxWarning: invalid escape sequence '\i'
File "Laplace/.venv/lib/python3.12/site-packages/_griffe/agents/visitor.py", line 203, in get_module
top_node = compile(self.code, mode="exec", filename=str(self.filepath), flags=ast.PyCF_ONLY_AST, optimize=1)
File "Laplace/laplace/lllaplace.py", line 510, in
"""Here not much changes in terms of GP inference compared to FunctionalLaplace class.
It also shows us some docstring parameter descriptions that we should fix:
WARNING - griffe: laplace/baselaplace.py:1957: Parameter 'num_data' does not appear in the function signature
WARNING - griffe: laplace/baselaplace.py:1957: Parameter 'diagonal_kernel' does not appear in the function signature
WARNING - griffe: laplace/baselaplace.py:1957: No types or annotations for parameters ['See']
WARNING - griffe: laplace/baselaplace.py:1957: Parameter 'See' does not appear in the function signature
WARNING - griffe: laplace/utils/matrix.py:296: Parameter 'dampen' does not appear in the function signature
WARNING - griffe: laplace/utils/subnetmask.py:361: No types or annotations for parameters ['parameter_names']
WARNING - griffe: laplace/utils/subnetmask.py:361: Parameter 'parameter_names' does not appear in the function signature
Should we open an issue to fix it after the PR?
For deploying the docs, I will disable the old docs once you merge.
runame
approved these changes
Oct 9, 2024
|
@aleximmer fixed the issues. For the improper docstrings, I agree, let's open an issue for this. I also want to refactor the codebase to make it more extendible. Feel free to merge and test whether the new docs site is properly deployed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #226.
I decided to use
mkdocs-material, which is the standard in Python (see Astral's docs etc.).@aleximmer, I added a deploy workflow. Could you disable the current one for
pdoc? (Seems like it's hidden in the repo settings page.)To review:
then open
localhost:8000